package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendPayMethodAddDTO;
import org.jsola.hr.dto.AttendPayMethodUpdateDTO;
import org.jsola.hr.query.AttendPayMethodQuery;
import org.jsola.hr.vo.AttendPayMethodListVO;
import org.jsola.hr.vo.AttendPayMethodVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-计薪方式")
public interface IAttendPayMethodControllerAPI {

    /**
     * 新增计薪方式
     * @param attendPayMethodAddDTO 计薪方式新增实体
     * @return 计薪方式展示对象
     */
    @ApiOperation(value = "新增计薪方式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodAddDTO", dataType = "AttendPayMethodAddDTO", value = "新增计薪方式", paramType = "body")
    })
    Result<AttendPayMethodVO> save(AttendPayMethodAddDTO attendPayMethodAddDTO);


    /**
     * 修改计薪方式
     * @param attendPayMethodUpdateDTO 计薪方式
     * @return 更新数量
     */
    @ApiOperation(value = "修改计薪方式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodUpdateDTO", dataType = "AttendPayMethodUpdateDTO", value = "修改计薪方式", paramType = "body")
    })
    Result<Integer> update(AttendPayMethodUpdateDTO attendPayMethodUpdateDTO);




    /**
     * 删除单个计薪方式，彻底删除
     * @param attendPayMethodId 计薪方式id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个计薪方式，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodId", dataType = "String", value = "计薪方式id", paramType = "path")
    })
    Result<Integer> delete(String attendPayMethodId);


    /**
     * 批量删除计薪方式，彻底删除
     * @param attendPayMethodIds 计薪方式id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除计薪方式，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodIds", dataType = "String[]", value = "计薪方式id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendPayMethodIds);


    /**
     * 根据计薪方式id查询计薪方式详情
     * @param attendPayMethodId 计薪方式id
     * @return 计薪方式详情
     */
    @ApiOperation(value="根据计薪方式id查询计薪方式详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodId", dataType = "String", value = "计薪方式id", paramType = "path")
    })
    Result<AttendPayMethodVO> findById(String attendPayMethodId);


    /**
     * 查询计薪方式
     * @param attendPayMethodQuery 计薪方式查询参数
     * @return page
     */
    @ApiOperation(value="查询计薪方式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodQuery", dataType = "AttendPayMethodQuery", value = "计薪方式查询参数", paramType = "query")
    })
    Result<List<AttendPayMethodListVO>> listAll(AttendPayMethodQuery attendPayMethodQuery);


     /**
     * 分页查询计薪方式
     * @param attendPayMethodQuery 计薪方式查询参数
     * @return page
     */
    @ApiOperation(value="分页查询计薪方式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPayMethodQuery", dataType = "AttendPayMethodQuery", value = "计薪方式查询参数", paramType = "query")
    })
    Result<Page<AttendPayMethodListVO>> page(AttendPayMethodQuery attendPayMethodQuery);


}

